<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - api.Channel</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/api.Access.html">api.Access</a></li>
	
	<li><a href="../symbols/api.Basic.html">api.Basic</a></li>
	
	<li><a href="../symbols/api.Channel.html">api.Channel</a></li>
	
	<li><a href="../symbols/api.Connection.html">api.Connection</a></li>
	
	<li><a href="../symbols/api.Dtx.html">api.Dtx</a></li>
	
	<li><a href="../symbols/api.Exchange.html">api.Exchange</a></li>
	
	<li><a href="../symbols/api.File.html">api.File</a></li>
	
	<li><a href="../symbols/api.Queue.html">api.Queue</a></li>
	
	<li><a href="../symbols/api.Stream.html">api.Stream</a></li>
	
	<li><a href="../symbols/api.Tunnel.html">api.Tunnel</a></li>
	
	<li><a href="../symbols/api.Tx.html">api.Tx</a></li>
	
	<li><a href="../symbols/handlers.html">handlers</a></li>
	
	<li><a href="../symbols/impl.html">impl</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class api.Channel
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_api_channel.js.html">channel.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class api.Channel.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/api.Channel.html#constructor">api.Channel</a></b>()
							</div>
							<div class="description">Work with channels.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class api.Channel.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#close">close</a></b>(replyCode, replyText, classId, methodId)
								</div>
								<div class="description">Request a channel close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#closeOk">closeOk</a></b>()
								</div>
								<div class="description">Confirm a channel close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#flow">flow</a></b>(active)
								</div>
								<div class="description">Enable/disable flow from peer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#flowOk">flowOk</a></b>(active)
								</div>
								<div class="description">Confirm a flow method.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#open">open</a></b>(outOfBand)
								</div>
								<div class="description">Open a channel for use.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class api.Channel.">
					<caption>Event Summary</caption>
					<thead>
						<tr>
							<th scope="col">Event Attributes</th>
							<th scope="col">Event Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#event:alert">alert</a></b>(replyCode, replyText, details)
								</div>
								<div class="description">Send a non-fatal warning message.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#event:close">close</a></b>(replyCode, replyText, classId, methodId)
								</div>
								<div class="description">Request a channel close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#event:closeOk">closeOk</a></b>()
								</div>
								<div class="description">Confirm a channel close.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#event:flow">flow</a></b>(active)
								</div>
								<div class="description">Enable/disable flow from peer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#event:flowOk">flowOk</a></b>(active)
								</div>
								<div class="description">Confirm a flow method.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/api.Channel.html#event:openOk">openOk</a></b>()
								</div>
								<div class="description">Signal that the channel is ready.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>api.Channel</b>()
				</div>
				
				<div class="description">
					Work with channels.

The channel class provides methods for a client to establish a virtual
  connection - a channel - to a server and for both peers to operate the
  virtual connection thereafter.
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="close"> </a>
					<div class="fixedFont">
					
					
					<b>close</b>(replyCode, replyText, classId, methodId)
					
					</div>
					<div class="description">
						Request a channel close.

This method indicates that the sender wants to close the channel.
    This may be due to internal conditions (e.g. a forced shut-down) or
    due to an error handling a specific method, i.e. an exception.  When
    a close is due to an exception, the sender provides the class and
    method id of the method which caused the exception.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>replyCode</b>
									
								</dt>
								<dd>The reply code. The AMQ reply codes are defined in AMQ RFC 011.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>replyText</b>
									
								</dt>
								<dd>The localised reply text.  This text can be logged as an aid to
  resolving issues.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>classId</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>methodId</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="closeOk"> </a>
					<div class="fixedFont">
					
					
					<b>closeOk</b>()
					
					</div>
					<div class="description">
						Confirm a channel close.

This method confirms a Channel.Close method and tells the recipient
    that it is safe to release resources for the channel and close the
    socket.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="flow"> </a>
					<div class="fixedFont">
					
					
					<b>flow</b>(active)
					
					</div>
					<div class="description">
						Enable/disable flow from peer.

This method asks the peer to pause or restart the flow of content
    data. This is a simple flow-control mechanism that a peer can use
    to avoid oveflowing its queues or otherwise finding itself receiving
    more messages than it can process.  Note that this method is not
    intended for window control.  The peer that receives a request to
    stop sending content should finish sending the current content, if
    any, and then wait until it receives a Flow restart method.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>active</b>
									
								</dt>
								<dd>If 1, the peer starts sending content frames.  If 0, the peer
      stops sending content frames.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="flowOk"> </a>
					<div class="fixedFont">
					
					
					<b>flowOk</b>(active)
					
					</div>
					<div class="description">
						Confirm a flow method.

Confirms to the peer that a flow command was received and processed.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>active</b>
									
								</dt>
								<dd>Confirms the setting of the processed flow method: 1 means the
      peer will start sending or continue to send content frames; 0
      means it will not.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="open"> </a>
					<div class="fixedFont">
					
					
					<b>open</b>(outOfBand)
					
					</div>
					<div class="description">
						Open a channel for use.

This method opens a virtual connection (a channel).
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>outOfBand</b>
									
								</dt>
								<dd>Configures out-of-band transfers on this channel.  The syntax and
      meaning of this field will be formally defined at a later date.</dd>
							
							</dl>
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
				<div class="sectionTitle">
					Event Detail
				</div>
				
					<a name="event:alert"> </a>
					<div class="fixedFont">
					
					
					<b>alert</b>(replyCode, replyText, details)
					
					</div>
					<div class="description">
						Send a non-fatal warning message.

This method allows the server to send a non-fatal warning to the
    client.  This is used for methods that are normally asynchronous
    and thus do not have confirmations, and for which the server may
    detect errors that need to be reported.  Fatal errors are handled
    as channel or connection exceptions; non-fatal errors are sent
    through this method.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>replyCode</b>
									
								</dt>
								<dd>The reply code. The AMQ reply codes are defined in AMQ RFC 011.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>replyText</b>
									
								</dt>
								<dd>The localised reply text.  This text can be logged as an aid to
  resolving issues.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>details</b>
									
								</dt>
								<dd>A set of fields that provide more information about the
      problem.  The meaning of these fields are defined on a
      per-reply-code basis (TO BE DEFINED).</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:close"> </a>
					<div class="fixedFont">
					
					
					<b>close</b>(replyCode, replyText, classId, methodId)
					
					</div>
					<div class="description">
						Request a channel close.

This method indicates that the sender wants to close the channel.
    This may be due to internal conditions (e.g. a forced shut-down) or
    due to an error handling a specific method, i.e. an exception.  When
    a close is due to an exception, the sender provides the class and
    method id of the method which caused the exception.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>replyCode</b>
									
								</dt>
								<dd>The reply code. The AMQ reply codes are defined in AMQ RFC 011.</dd>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>replyText</b>
									
								</dt>
								<dd>The localised reply text.  This text can be logged as an aid to
  resolving issues.</dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>classId</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Number}</span> <b>methodId</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:closeOk"> </a>
					<div class="fixedFont">
					
					
					<b>closeOk</b>()
					
					</div>
					<div class="description">
						Confirm a channel close.

This method confirms a Channel.Close method and tells the recipient
    that it is safe to release resources for the channel and close the
    socket.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:flow"> </a>
					<div class="fixedFont">
					
					
					<b>flow</b>(active)
					
					</div>
					<div class="description">
						Enable/disable flow from peer.

This method asks the peer to pause or restart the flow of content
    data. This is a simple flow-control mechanism that a peer can use
    to avoid oveflowing its queues or otherwise finding itself receiving
    more messages than it can process.  Note that this method is not
    intended for window control.  The peer that receives a request to
    stop sending content should finish sending the current content, if
    any, and then wait until it receives a Flow restart method.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>active</b>
									
								</dt>
								<dd>If 1, the peer starts sending content frames.  If 0, the peer
      stops sending content frames.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:flowOk"> </a>
					<div class="fixedFont">
					
					
					<b>flowOk</b>(active)
					
					</div>
					<div class="description">
						Confirm a flow method.

Confirms to the peer that a flow command was received and processed.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>active</b>
									
								</dt>
								<dd>Confirms the setting of the processed flow method: 1 means the
      peer will start sending or continue to send content frames; 0
      means it will not.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="event:openOk"> </a>
					<div class="fixedFont">
					
					
					<b>openOk</b>()
					
					</div>
					<div class="description">
						Signal that the channel is ready.

This method signals to the client that the channel is ready for use.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Nov 04 2010 22:16:21 GMT+0200 (EET)
		</div>
	</body>
</html>
